Enable pre-commit hooks#1349
Merged
davidharrishmc merged 6 commits intoopenhwgroup:mainfrom Apr 9, 2025
Merged
Conversation
Contributor
|
This scares me a little bit. If you ever graduate and something breaks, I'll never figure out how to fix it. |
Contributor
|
Do we want to try it for a week or two on separate branch and push intentionally malformed test files? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add pre-commit hooks to ensure all lint rules pass before committing. This avoids repeatedly pushing to GitHub to try resolving a lint error.
The setup script is updated to automatically enable the pre-commit hooks whenever someone clones the repo and the installation files are updated to install
pre-commitwhen running the main toolchain install.Migrates the existing ruff lint to run in pre-commit hooks and adds several other basic checks (no large files, no merge conflict indicator marks, parseable yaml/json files, etc.).
There are several other pre-commit hooks that we should enable, but they touch a decent number of files so I'll do them as separate PRs to make it easier to review.